home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2000 January / Macworld (2000-01).dmg / Shareware World / Education / Eng-Italian Dictionary 5.6 .sea / Eng-Italian Dictionary 5.6 / English-Italian Dictionary 5.6 / English Documentation / To create plug-ins / How to create a plug-in < prev    next >
Text File  |  1999-10-19  |  7KB  |  114 lines
  1. How to create a plug-in
  2.  
  3.  
  4. Contents:
  5. 1) What is a plug-in?
  6. 2) How is a plug-in created?
  7. 3) Distributing plug-ins.
  8. 4) Guidelines.
  9.  
  10.  
  11. 1) What is a plug-in?
  12. Wecan English-Italian Dictionary is based on a new technology called OpenDictionary. This lets anyone create plug-in dictionaries to supplement the dictionary provided with the program. Any user can create a plug-in dictionary to suit his own needs. For example a doctor could feel the need to expand the main dictionary by creating a plug-in to hold medical terms, or an internet user could create a plug-in for the English terms that are most frequently found on the net, and so on.  
  13.  
  14.  
  15. 2) How is a plug-in created?
  16. Creating a plug-in is very simple:
  17.  
  18. a) Use FileMaker™ (version 2.1 or higher) to open the file called “Create plug-in”. If you don't have FileMaker, you can use a word-processing program to prepare a text-file instead (please see below). If you use “Create plug-in”, enter the words you want to include, and their translations.
  19. You can enter the same word more than once. This means that, if you want to, you can include a word in a plug-in even if it is already included in the main dictionary, or in another plug-in. When you search for the word, the program will display all the entries for it.  
  20.  
  21. b) To export the words press the “Export” button, then:
  22.  
  23.    • In the next window type the name you prefer for the file.
  24.    • Choose the format “Tab-separated Text”, and press the “New” button.
  25.    • In the next window press the “OK” button.
  26.  
  27. c) The final step is to convert the file you have just created so that it will work as a plug-in. Open Wecan English-Italian Dictionary and choose “Convert to plug-in…” from the File menu. 
  28.  
  29. Put the plug-in into the Plug-ins folder of Wecan English-Italian Dictionary. You don't have to do anything else. Wecan English-Italian Dictionary will have immediate access to the plug-in you have created.
  30.  
  31. There is no limit to the number of plug-ins you can install. What's more, you can add a plug-in while the program is running, and you will have access to the extra words without even having to relaunch the program. 
  32.  
  33. To de-install a plug-in, just drag it out of the Plug-ins folder.
  34.  
  35. You can create a plug-in without using the file called “Create plug-in”. You can use ClarisWorks, or a word-processing program such as SimpleText ™, Style ™, or MicroSoft Word ™. When you save the file, choose "Save As..." on the File menu, and make sure that you save the file either in ASCII format or as TEXT, rather than in the normal format for the program concerned (but SimpleText files can be saved in the ordinary way). In addition, you need to follow this pattern when you make entries in the file: 
  36.  
  37. <Word 1> Tab <Translation 1> Return
  38. <Word 2> Tab <Translation 2> Return
  39. <Word 3> Tab <Translation 3> Return
  40. and so on…
  41.  
  42. To make an entry for one English word and its translation, type the English word, for instance “apple”, then press the Tab key on your keyboard. Next, type the translation for that word, for instance “(n) mela, pomo.”, then press the Return key on your keyboard. This completes the first entry and leaves you ready to make another entry. 
  43.  
  44.  
  45. 3) Distributing plug-ins.
  46. If you want to share your work with other users of Wecan English-Italian Dictionary, you can distribute your plug-ins in the spirit that makes Wecan English-Italian Dictionary a unique program.
  47. You can distribute a plug-in by sending it to a computer magazine that carries CD-ROMs (Mac Format, MacWorld, etc.). You can also make your plug-in available on the Internet. To do this, send it by email to one of the many ftp sites dedicated to the Macintosh, for instance to Info-Mac which is one of the major sites.
  48.  
  49. Put the plug-in into a folder, and enclose a file to describe the contents of the plug-in (this file is often called “Read Me”). You can find an example of a Read Me in the folder containing the file you are reading now. Then compress the folder, using a utility program such as DropStuff™, and send it by email.
  50.  
  51. The registration code of Wecan English-Italian Dictionary is personal to you. Please do not distribute either the code itself or registered copies of Wecan English-Italian Dictionary (because they contain the code). A new user can use a demo copy of Wecan English-Italian Dictionary to evaluate the program. A demo copy has the same features, except that the translations for certain words are hidden. If a new user likes the program he or she can register it. 
  52.  
  53. Here is an example of a letter you could send to Info-Mac with a hypothetical plug-in called “Medical Words”:
  54.  
  55. ======================================
  56. To: macgifts@info-mac.org
  57. Subject: Medical Words - Plug-in for Wecan English-Italian Dictionary.
  58.  
  59. Dear archivist,
  60.  
  61. This file is "Medical Words", a plug-in for Wecan English-Italian Dictionary.
  62.  
  63. Abstract:
  64. Medical Words is a plug-in for Wecan English-Italian Dictionary containing more than 2,000 English medical words with translations into Italian.
  65.  
  66. I give permission for "Medical Words" to be included on the Info-Mac CD-ROM.
  67.  
  68. Distribution Info
  69. This software can be freely distributed, either online or on CD-ROM without restrictions, provided that the original package is included.
  70.  
  71.  
  72. Dr. John Smith
  73.  
  74. John Smith Home Page: http://www.provider.com/john
  75. John Smith E-mail: john@provider.com
  76. ======================================
  77.  
  78. To find detailed information about sending files to Info-Mac, visit their Web site: http://www.pht.com/info-mac
  79.  
  80.  
  81. 4) Guidelines
  82. If you want, you can follow a few simple guidelines for plug-in dictionaries that you plan to distribute. The use of the guidelines will lead to consistency between plug-ins written by different authors, and will help to create a familiar environment for the end-user.
  83. Here are examples of some words contained in the main dictionary of Wecan English-Italian Dictionary:
  84.  
  85. apple    (n) mela, pomo.
  86. ASCII    (=American Standard Code for Information Interchange).
  87. bound    (n) confine, salto, scatto; (a) legato; (vt) limitare; (vi) saltare; pass e pp del verbo bind.
  88. B&B    (=bed-and-breakfast) camera con colazione.
  89. change    (vt, vi) cambiare, cambiarsi.
  90. enlarge    (vt) espandere, estendere, ingrandire; (vi) allargarsi.
  91. much    (a, av) molto.
  92. Paddy    (n) uomo irlandese (abbrev. di Patrick).
  93. ppm    (=pages per minute) pagine al minuto.
  94. quoit    (n) anello di corda, metallo o gomma (usato per giocare).
  95. scissors    (n, pl) forbici.
  96. try    (vi, vt) cercare, provare, tentare.
  97. understood    (a) compreso, capito; implicito, sottinteso.
  98.  
  99. a) The words are normally written in lower-case (small) letters, for instance “apple”. Of course some words need a capital for certain letters, for instance names like “Paddy”. 
  100. b) There is a full stop or period at the end of each translation.
  101. c) It is helpful to users to show whether the word is a noun or a verb, etc. Standard abbreviations for these are shown in the main window of Wecan English-Italian Dictionary, and can be used without a dot. If you need to abbreviate a word not shown in that window, try to use a full stop or period after it (e.g. “abbrev.” in the entry for “Paddy”.) 
  102. d) Comments should be in brackets (for instance “usato per giocare” in the entry for “quoit”).
  103. e) Use semicolons to separate different meanings in the translation, for example in the entries for “bound” and for “understood”.
  104.  
  105.  
  106.  
  107. Buon lavoro!
  108. The Wecan English-Italian Dictionary Team
  109.  
  110.  
  111.  
  112.  
  113. OneApp Software
  114. http://www.oneappsoftware.com/